<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ClaraGenomicsAnalysis: claragenomics::cudamapper::SketchElement Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ClaraGenomicsAnalysis
   &#160;<span id="projectnumber">0.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><b>claragenomics</b></li><li class="navelem"><b>cudamapper</b></li><li class="navelem"><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html">SketchElement</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classclaragenomics_1_1cudamapper_1_1SketchElement-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">claragenomics::cudamapper::SketchElement Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__cudamapper.html">CUDA mapper package</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html" title="SketchElement - Contains integer representation, position, direction and read id of a kmer.">SketchElement</a> - Contains integer representation, position, direction and read id of a kmer.  
 <a href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="sketch__element_8hpp_source.html">sketch_element.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a83beb5c091c4b0bfec99c04b6bc8777a"><td class="memItemLeft" align="right" valign="top"><a id="a83beb5c091c4b0bfec99c04b6bc8777a"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#a83beb5c091c4b0bfec99c04b6bc8777a">DirectionOfRepresentation</a> { <b>FORWARD</b>, 
<b>REVERSE</b>
 }</td></tr>
<tr class="memdesc:a83beb5c091c4b0bfec99c04b6bc8777a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Is this a representation of forward or reverse compliment. <br /></td></tr>
<tr class="separator:a83beb5c091c4b0bfec99c04b6bc8777a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac62560de124742cb23bc1def0a0b2069"><td class="memItemLeft" align="right" valign="top"><a id="ac62560de124742cb23bc1def0a0b2069"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#ac62560de124742cb23bc1def0a0b2069">~SketchElement</a> ()=default</td></tr>
<tr class="memdesc:ac62560de124742cb23bc1def0a0b2069"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor for <a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html" title="SketchElement - Contains integer representation, position, direction and read id of a kmer.">SketchElement</a>. <br /></td></tr>
<tr class="separator:ac62560de124742cb23bc1def0a0b2069"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb3c8927594ba5f077c4443c229e0730"><td class="memItemLeft" align="right" valign="top">virtual representation_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#abb3c8927594ba5f077c4443c229e0730">representation</a> () const =0</td></tr>
<tr class="memdesc:abb3c8927594ba5f077c4443c229e0730"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns integer representation of a kmer  <a href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#abb3c8927594ba5f077c4443c229e0730">More...</a><br /></td></tr>
<tr class="separator:abb3c8927594ba5f077c4443c229e0730"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ddea36eed82ea3a9d1fa7ace61051bc"><td class="memItemLeft" align="right" valign="top">virtual position_in_read_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#a0ddea36eed82ea3a9d1fa7ace61051bc">position_in_read</a> () const =0</td></tr>
<tr class="memdesc:a0ddea36eed82ea3a9d1fa7ace61051bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns position of the sketch in the read  <a href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#a0ddea36eed82ea3a9d1fa7ace61051bc">More...</a><br /></td></tr>
<tr class="separator:a0ddea36eed82ea3a9d1fa7ace61051bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4b53bc09f5816c3b81fef1c1abf3fc6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#a83beb5c091c4b0bfec99c04b6bc8777a">DirectionOfRepresentation</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#af4b53bc09f5816c3b81fef1c1abf3fc6">direction</a> () const =0</td></tr>
<tr class="memdesc:af4b53bc09f5816c3b81fef1c1abf3fc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns representation's direction  <a href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#af4b53bc09f5816c3b81fef1c1abf3fc6">More...</a><br /></td></tr>
<tr class="separator:af4b53bc09f5816c3b81fef1c1abf3fc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5f2e8fc8df725b336833930baf3cd39"><td class="memItemLeft" align="right" valign="top">virtual read_id_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#af5f2e8fc8df725b336833930baf3cd39">read_id</a> () const =0</td></tr>
<tr class="memdesc:af5f2e8fc8df725b336833930baf3cd39"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns read ID  <a href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#af5f2e8fc8df725b336833930baf3cd39">More...</a><br /></td></tr>
<tr class="separator:af5f2e8fc8df725b336833930baf3cd39"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html" title="SketchElement - Contains integer representation, position, direction and read id of a kmer.">SketchElement</a> - Contains integer representation, position, direction and read id of a kmer. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af4b53bc09f5816c3b81fef1c1abf3fc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af4b53bc09f5816c3b81fef1c1abf3fc6">&#9670;&nbsp;</a></span>direction()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classclaragenomics_1_1cudamapper_1_1SketchElement.html#a83beb5c091c4b0bfec99c04b6bc8777a">DirectionOfRepresentation</a> claragenomics::cudamapper::SketchElement::direction </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns representation's direction </p>
<dl class="section return"><dt>Returns</dt><dd>representation's direction </dd></dl>

</div>
</div>
<a id="a0ddea36eed82ea3a9d1fa7ace61051bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ddea36eed82ea3a9d1fa7ace61051bc">&#9670;&nbsp;</a></span>position_in_read()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual position_in_read_t claragenomics::cudamapper::SketchElement::position_in_read </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns position of the sketch in the read </p>
<dl class="section return"><dt>Returns</dt><dd>position of the sketch in the read </dd></dl>

</div>
</div>
<a id="af5f2e8fc8df725b336833930baf3cd39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5f2e8fc8df725b336833930baf3cd39">&#9670;&nbsp;</a></span>read_id()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual read_id_t claragenomics::cudamapper::SketchElement::read_id </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns read ID </p>
<dl class="section return"><dt>Returns</dt><dd>read ID </dd></dl>

</div>
</div>
<a id="abb3c8927594ba5f077c4443c229e0730"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb3c8927594ba5f077c4443c229e0730">&#9670;&nbsp;</a></span>representation()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual representation_t claragenomics::cudamapper::SketchElement::representation </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>returns integer representation of a kmer </p>
<dl class="section return"><dt>Returns</dt><dd>integer representation </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>cudamapper/include/claragenomics/cudamapper/<a class="el" href="sketch__element_8hpp_source.html">sketch_element.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
